OpenTelemetry - Installation and configuration

Prerequisites

1. Have a locally installed Boomi runtime.
2. Have Runtime Management privileges.

Observability Tooling Prerequisites

1. Install or reference a third party application monitoring tool that supports OpenTelemetry (list of supported vendors).
2. Optional: Install and configure a local collector. Obtain connection details for the endpoint application or collector.
   1. URL and port
   2. Authentication - If required, typically will be a user name and password, or API token.

Setup

Configuration is currently performed through RuntimeObservabilitySettings API. A user interface is planned for a future release.

Below is a summary of the configuration options and considerations.

1. Enable Observability for the runtime.
   1. When enabling observability, the runtime must be restarted. Once enabled, future changes to the observability configuration only require a restart of the plugin, not the entire runtime. Keep in mind observability data is not generated nor exported while the runtime or plugin is restarting.
2. Configure global endpoint information to where telemetry data should be sent. Note this can be overridden per data type below.
   1. URL - Endpoint for monitoring application or collector. Must be accessible to the runtime.
   2. Authentication Type - If applicable, the authentication type and credentials required to access the monitoring application or collector.
3. Metrics
   1. Enable metrics to begin exporting runtime application metrics.
   2. Optional - Override metrics endpoint if need to send to a different monitoring endpoint.
   3. Optional - Configure advanced settings to optimize transmission as needed.
4. Enable and configure logs.
   1. Enable logs to begin exporting runtime and process execution logs.
   2. Optional - Override logs endpoint if need to send to a different monitoring endpoint.
   3. Choose to export all logs or only selected logs.
   4. Optional - Configure advanced settings to optimize transmission as needed.
5. Enable and configure traces.
   1. Enable traces to begin exporting process execution traces.
   2. Optional - Override traces endpoint if need to send to a different monitoring endpoint.
   3. Choose to export traces for all processes or only selected processes.
   4. Optional - Configure advanced settings to optimize transmission as needed.